<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: util/detail/util_fwd.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_a762a7cb84c76c9561dbc78c61068184.html">util</a></li><li class="navelem"><a class="el" href="dir_b5fa8338842f1288129dabc4bfd9a8d3.html">detail</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">util_fwd.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="detail_2util__fwd_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Core</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="util__fwd_8hpp.html">ipc/util/util_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="shared__name__fwd_8hpp.html">ipc/util/shared_name_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &lt;flow/common.hpp&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;boost/array.hpp&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1util.html">ipc::util</a></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>{</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"></span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">/// Short-hand for anonymous pipe write end.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#a844d5ca9c17b672644fc8d9dbe758db0">   32</a></span><span class="comment"></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceipc_1_1util.html#a844d5ca9c17b672644fc8d9dbe758db0">Pipe_writer</a> = boost::asio::writable_pipe;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"></span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment">/// Short-hand for anonymous pipe read end.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#aaf368acf8243bb25de3eef4e836c15de">   35</a></span><span class="comment"></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceipc_1_1util.html#aaf368acf8243bb25de3eef4e836c15de">Pipe_reader</a> = boost::asio::readable_pipe;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment">// Constants.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"></span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment">/**</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * Maps general Permissions_level specifier to low-level #Permissions value, when the underlying resource</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * is in the file-system and is either accessible (read-write in terms of file system) or inaccessible.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * Examples of such resources are SHM pools (in Linux living in &quot;/dev/shm&quot;) and POSIX MQs (&quot;/dev/mqueue&quot;).</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> *</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * See any additional user-facing notes in shared_resource_permissions() doc header.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> */</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="keyword">extern</span> <span class="keyword">const</span> boost::array&lt;<a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>, size_t(<a class="code hl_enumvalue" href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705da6fba12db09e5bebfaa04f6372c41c2cf">Permissions_level::S_END_SENTINEL</a>)&gt;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>  <a class="code hl_variable" href="namespaceipc_1_1util.html#a5716a13eb4de32e516ca257e025d8c20">SHARED_RESOURCE_PERMISSIONS_LVL_MAP</a>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"></span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment">/**</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> * Maps general Permissions_level specifier to low-level #Permissions value, when the underlying resource</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * is in the file-system (e.g., a file) and is *produced* (and therefore always writable) by the owning (creating,</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * updating) user; but *consumed* (and therefore at most readable, never writable) by potentially other processes,</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * and therefore possibly other users (e.g., group access or unrestricted access -- but only for reading either way).</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * For example a PID file is typically only writable by the daemon&#39;s user but may be readable or inaccessible by</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * other users.</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> */</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="keyword">extern</span> <span class="keyword">const</span> boost::array&lt;<a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>, size_t(<a class="code hl_enumvalue" href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705da6fba12db09e5bebfaa04f6372c41c2cf">Permissions_level::S_END_SENTINEL</a>)&gt;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>  <a class="code hl_variable" href="namespaceipc_1_1util.html#aa74a8b46a5b38021c662a0b3bdfb46bf">PRODUCER_CONSUMER_RESOURCE_PERMISSIONS_LVL_MAP</a>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="preprocessor">#ifndef FLOW_OS_LINUX</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="keyword">static_assert</span>(<span class="keyword">false</span>, <span class="stringliteral">&quot;IPC_KERNEL_PERSISTENT_RUN_DIR (/var/run) semantics require Unix; &quot;</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>                       <span class="stringliteral">&quot;tested in Linux specifically only.&quot;</span>);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="preprocessor">#endif</span><span class="comment"></span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment">/**</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> * Absolute path to the directory (without trailing separator) in the file system where kernel-persistent</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> * runtime, but not temporary, information shall be placed.  Kernel-persistent means that it&#39;ll disappear</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * at reboot; runtime, but not temporary, means it&#39;s... not the designated temporary-data directory (informally:</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * not /tmp).  Informally: just know that it is /var/run, and that it stores things such as process-ID (PID)</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> * files.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> *</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> * It is a Unix path, absolute (starts with forward-slash), and lexically normal (and lacks a root-name).</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> */</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="keyword">extern</span> <span class="keyword">const</span> fs::path <a class="code hl_variable" href="namespaceipc_1_1util.html#aaaa1fe31f8d77f78345dec8fc95e9882">IPC_KERNEL_PERSISTENT_RUN_DIR</a>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">// Free functions.</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"></span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">/**</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> * Internal (to ::ipc) utility that invokes the given function that invokes a boost.interprocess operation</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * that is documented to throw `bipc::interprocess_exception` on failure; if indeed it throws the utility</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> * emits an error in the Flow error-reporting style.  On error it logs WARNING with all available details.</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> *</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> * ### Background ###</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> * boost.interprocess has a number of operations that are documented to throw the aforementioned exception</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> * on error -- without any alternate way of reporting an error such as through an out-arg.  Moreover the</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> * exception itself is not any standard runtime-exception type but rather a custom thing.  This is somewhat</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> * annoying; and various parts of ::ipc want to emit errors in a consistent way.  That does *not* mean</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> * we must only emit some `transport::error::Code::*` or whatever, but we should emit a native-based #Error_code</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * if applicable, either as an out-arg or as a `flow::error::Runtime_error` wrapping it, or indeed one of our</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> * own codes otherwise (or if it is more applicable).</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> *</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> * So this helper standardizes that stuff.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> *</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> * @tparam Func</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> *         Functor that takes no args and returns nothing.</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> * @param logger_ptr</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> *        Logger to use for logging subsequently.</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> * @param err_code</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> *        `err_code` as-if passed to our API.  `*err_code` shall be set if not null depending on success/failure;</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> *        if null and no problem, won&#39;t throw; if null and problem will throw `Runtime_error` containing a truthy</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> *        #Error_code.  That&#39;s the usual Flow-style error emission semantics.</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> * @param misc_bipc_lib_error</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> *        If `func` throws, and we are unable to suss out the system error that caused it, then emit</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> *        this value.  E.g.: transport::Code::S_MQ_BIPC_MISC_LIBRARY_ERROR makes sense if creating</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> *        a `bipc::message_queue`; or a similar one for SHM-related parts of `bipc`; etc.</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> * @param context</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> *        Description for logging of the op being attempted, in case there is an error.  Compile-time-known strings</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> *        are best, as this is not protected by a filtering macro and hence will be evaluated no matter what.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> * @param func</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> *        `func()` shall be executed synchronously.</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> */</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Func&gt;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1util.html#abd43da87aa17031604c7906757c07d46">op_with_possible_bipc_exception</a>(flow::log::Logger* logger_ptr, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code,</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span>                                     <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>&amp; misc_bipc_lib_error,</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span>                                     <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">String_view</a> context,</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>                                     <span class="keyword">const</span> Func&amp; func);</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"></span> </div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment">/**</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> * Writes a byte to the given pipe writer.  If any error occurs =&gt; undefined behavior (assert may trip).</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * If it would-block... it will block.  So: only use if your algorithm has made sure you will never reach the</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> * pipe&#39;s capacity.</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> *</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> * @param logger_ptr</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> *        Logger to use for logging subsequently.</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> * @param pipe</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> *        The pipe.</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> */</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1util.html#a5429c6225cc9a271ad8c0041d99c236b">pipe_produce</a>(flow::log::Logger* logger_ptr, <a class="code hl_typedef" href="namespaceipc_1_1util.html#a844d5ca9c17b672644fc8d9dbe758db0">Pipe_writer</a>* pipe);</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"></span> </div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">/**</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> * Reads a byte via the given pipe reader.  If any error occurs =&gt; undefined behavior (assert may trip).</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> * If it would-block... it will block.  So: only use if your algorithm has made sure you have a byte in there.</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> *</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> * @param logger_ptr</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> *        Logger to use for logging subsequently.</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> * @param pipe</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> *        The pipe.</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> */</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1util.html#a814272e555c0592b0caf92b7bc3d64b3">pipe_consume</a>(flow::log::Logger* logger_ptr, <a class="code hl_typedef" href="namespaceipc_1_1util.html#aaf368acf8243bb25de3eef4e836c15de">Pipe_reader</a>* pipe);</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"></span> </div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment">/**</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> * Builds an absolute name according to the path convention explained in Shared_name class doc header;</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"> * this overload applies to resources *outside* the ipc::session paradigm.  Typically one</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"> * would then add a Shared_name::S_SEPARATOR and then purpose-specific path component(s) (via `/=` or similar).</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> *</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> * Behavior is undefined if a path fragment argument is empty (assertion may trip).</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> *</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> * @param resource_type</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> *        Resource type constant.  Typically it is available as a `S_RESOURCE_TYPE_ID` constant in some class;</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> *        otherwise as a `Shared_name::S_RESOURCE_TYPE_ID_*` constant.</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> * @return Absolute path not ending in `S_SEPARATOR`, typically to be appended with a `S_SEPARATOR` and more</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> *         component(s) by the caller.</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> */</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="namespaceipc_1_1util.html#a71fa0c2bd2c45109a9fbab4b048c666d">build_conventional_non_session_based_shared_name</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; resource_type);</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"></span> </div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment">/**</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> * Implementation of `Persistent_object::for_each_persistent()`; for example see</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> * shm::classic::Pool_arena::for_each_persistent().  It relies on the OS feature wherein each particular</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> * `Persistent_object` (kernel-persistent object) type is listed in flat fashion in a particular</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> * directory; `persistent_obj_dev_dir_path` must specify this directory.</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> *</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> * Conceptually, we shall perform `ls D/`, where `D` is `persistent_obj_dev_dir_path`.  Then for each</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> * resulting `D/N`, we shall call `handle_name_func(N)`.</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> *</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> * ### Errors (or lack thereof) ###</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> * There is no error condition.  If `persistent_obj_dev_dir_path` does not exist, or we lack permissions to</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> * look therein, it merely means it cannot contain any relevant items; hence `handle_name_func()` is not invoked.</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> *</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> * @tparam Handle_name_func</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> *         See, e.g., shm::classic::Pool_arena::for_each_persistent().</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> * @param persistent_obj_dev_dir_path</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> *        This must be an absolute path, or behavior is undefined (assertion may trip).  See above.</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> * @param handle_name_func</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> *        See `Handle_name_func`.</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> */</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handle_name_func&gt;</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1util.html#a49b39ceb74614b5f2d26dd86fd71bcb3">for_each_persistent_impl</a>(<span class="keyword">const</span> fs::path&amp; persistent_obj_dev_dir_path, <span class="keyword">const</span> Handle_name_func&amp; handle_name_func);</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"></span> </div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment">/**</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> * Equivalent to shm::classic::Pool_arena::for_each_persistent().  Provided here (for internal purposes as of this</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> * writing) to avoid a little circular-inter-component-dependent problem: Posix_mq_handle::for_each_persistent()</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> * needs us; but accessing `Pool_arena` would mean `ipc_core` Flow-IPC sub-component needing `ipc_shm`</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> * sub-component as a dependency... but the reverse is already naturally the case.  See ::ipc namespace doc header</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> * for discussion of the component hierarchy and how we prefer to avoid circular dependencies therein.</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> *</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> * @tparam Handle_name_func</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> *         See above.</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> * @param handle_name_func</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> *        See above.</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> */</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handle_name_func&gt;</div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1util.html#a74135195ff6c2f840092c21e522f964a">for_each_persistent_shm_pool</a>(<span class="keyword">const</span> Handle_name_func&amp; handle_name_func);</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"></span> </div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment">/**</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment"> * Equivalent to shm::classic::Pool_arena::remove_persistent().  Provided for similar reason to that described</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"> * in for_each_persistent_shm_pool() doc header nearby.</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"> *</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment"> * @param logger_ptr</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"> *        See above.</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment"> * @param name</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"> *        See above.</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment"> * @param err_code</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment"> *        See above.</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment"> */</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">remove_persistent_shm_pool</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; name, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code);</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span> </div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span>} <span class="comment">// namespace ipc::util</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span> </div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util_1_1sync__io.html">  208</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1util_1_1sync__io.html">ipc::util::sync_io</a></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span>{</div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span> </div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span> </div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment">// Find doc headers near the bodies of these compound types.</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span> </div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html">Timer_event_emitter</a>;</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span> </div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment">// Free functions.</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment"></span> </div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment">/**</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment"> * Prints string representation of the given `Timer_event_emitter` to the given `ostream`.</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment"> *</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment"> * @relatesalso Timer_event_emitter</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment"> *</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment"> */</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1util_1_1sync__io.html#adef3ac3be5570b22492dd9214b4cb3da">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html">Timer_event_emitter</a>&amp; val);</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span> </div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span>} <span class="comment">// namespace ipc::util::sync_io</span></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html">ipc::util::Shared_name</a></div><div class="ttdoc">String-wrapping abstraction representing a name uniquely distinguishing a kernel-persistent entity fr...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00241">shared_name.hpp:242</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html">ipc::util::sync_io::Timer_event_emitter</a></div><div class="ttdoc">An object of this type, used internally to implement sync_io-pattern objects that require timer event...</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8hpp_source.html#l00145">timer_ev_emitter.hpp:148</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_1_1sync__io_html"><div class="ttname"><a href="namespaceipc_1_1util_1_1sync__io.html">ipc::util::sync_io</a></div><div class="ttdoc">Contains common code, as well as important explanatory documentation in the following text,...</div><div class="ttdef"><b>Definition:</b> <a href="detail_2util__fwd_8hpp_source.html#l00208">util_fwd.hpp:209</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_1_1sync__io_html_adef3ac3be5570b22492dd9214b4cb3da"><div class="ttname"><a href="namespaceipc_1_1util_1_1sync__io.html#adef3ac3be5570b22492dd9214b4cb3da">ipc::util::sync_io::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Timer_event_emitter &amp;val)</div><div class="ttdoc">Prints string representation of the given Timer_event_emitter to the given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8cpp_source.html#l00131">timer_ev_emitter.cpp:131</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html"><div class="ttname"><a href="namespaceipc_1_1util.html">ipc::util</a></div><div class="ttdoc">Flow-IPC module containing miscellaneous general-use facilities that ubiquitously used by ~all Flow-I...</div><div class="ttdef"><b>Definition:</b> <a href="default__init__allocator_8hpp_source.html#l00023">default_init_allocator.hpp:24</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a1b398ae730d1e6040687cb2397115152"><div class="ttname"><a href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">ipc::util::Permissions</a></div><div class="ttdeci">bipc::permissions Permissions</div><div class="ttdoc">Short-hand for Unix (POSIX) permissions class.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00161">util_fwd.hpp:161</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a1cdc0a8d761170faa844c49d37c522ff"><div class="ttname"><a href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">ipc::util::remove_persistent_shm_pool</a></div><div class="ttdeci">void remove_persistent_shm_pool(flow::log::Logger *logger_ptr, const Shared_name &amp;pool_name, Error_code *err_code)</div><div class="ttdoc">Equivalent to shm::classic::Pool_arena::remove_persistent().</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00119">util.cpp:119</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a2ec0bfdddb41a1ef0403e4bb8967705da6fba12db09e5bebfaa04f6372c41c2cf"><div class="ttname"><a href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705da6fba12db09e5bebfaa04f6372c41c2cf">ipc::util::Permissions_level::S_END_SENTINEL</a></div><div class="ttdeci">@ S_END_SENTINEL</div><div class="ttdoc">Sentinel: not a valid value. May be used to, e.g., size an array&lt;&gt; mapping from Permissions_level.</div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a49b39ceb74614b5f2d26dd86fd71bcb3"><div class="ttname"><a href="namespaceipc_1_1util.html#a49b39ceb74614b5f2d26dd86fd71bcb3">ipc::util::for_each_persistent_impl</a></div><div class="ttdeci">void for_each_persistent_impl(const fs::path &amp;persistent_obj_dev_dir_path, const Handle_name_func &amp;handle_name_func)</div><div class="ttdoc">Implementation of Persistent_object::for_each_persistent(); for example see shm::classic::Pool_arena:...</div><div class="ttdef"><b>Definition:</b> <a href="util_8hpp_source.html#l00090">util.hpp:90</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a5429c6225cc9a271ad8c0041d99c236b"><div class="ttname"><a href="namespaceipc_1_1util.html#a5429c6225cc9a271ad8c0041d99c236b">ipc::util::pipe_produce</a></div><div class="ttdeci">void pipe_produce(flow::log::Logger *logger_ptr, Pipe_writer *pipe)</div><div class="ttdoc">Writes a byte to the given pipe writer.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00067">util.cpp:67</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a5716a13eb4de32e516ca257e025d8c20"><div class="ttname"><a href="namespaceipc_1_1util.html#a5716a13eb4de32e516ca257e025d8c20">ipc::util::SHARED_RESOURCE_PERMISSIONS_LVL_MAP</a></div><div class="ttdeci">const boost::array&lt; Permissions, size_t(Permissions_level::S_END_SENTINEL)&gt; SHARED_RESOURCE_PERMISSIONS_LVL_MAP</div><div class="ttdoc">Maps general Permissions_level specifier to low-level Permissions value, when the underlying resource...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00033">util.cpp:34</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a71fa0c2bd2c45109a9fbab4b048c666d"><div class="ttname"><a href="namespaceipc_1_1util.html#a71fa0c2bd2c45109a9fbab4b048c666d">ipc::util::build_conventional_non_session_based_shared_name</a></div><div class="ttdeci">Shared_name build_conventional_non_session_based_shared_name(const Shared_name &amp;resource_type)</div><div class="ttdoc">Builds an absolute name according to the path convention explained in Shared_name class doc header; t...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00337">shared_name.cpp:337</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a74135195ff6c2f840092c21e522f964a"><div class="ttname"><a href="namespaceipc_1_1util.html#a74135195ff6c2f840092c21e522f964a">ipc::util::for_each_persistent_shm_pool</a></div><div class="ttdeci">void for_each_persistent_shm_pool(const Handle_name_func &amp;handle_name_func)</div><div class="ttdoc">Equivalent to shm::classic::Pool_arena::for_each_persistent().</div><div class="ttdef"><b>Definition:</b> <a href="util_8hpp_source.html#l00131">util.hpp:131</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a814272e555c0592b0caf92b7bc3d64b3"><div class="ttname"><a href="namespaceipc_1_1util.html#a814272e555c0592b0caf92b7bc3d64b3">ipc::util::pipe_consume</a></div><div class="ttdeci">void pipe_consume(flow::log::Logger *logger_ptr, Pipe_reader *pipe)</div><div class="ttdoc">Reads a byte via the given pipe reader.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00096">util.cpp:96</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a844d5ca9c17b672644fc8d9dbe758db0"><div class="ttname"><a href="namespaceipc_1_1util.html#a844d5ca9c17b672644fc8d9dbe758db0">ipc::util::Pipe_writer</a></div><div class="ttdeci">boost::asio::writable_pipe Pipe_writer</div><div class="ttdoc">Short-hand for anonymous pipe write end.</div><div class="ttdef"><b>Definition:</b> <a href="detail_2util__fwd_8hpp_source.html#l00032">util_fwd.hpp:32</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_aa74a8b46a5b38021c662a0b3bdfb46bf"><div class="ttname"><a href="namespaceipc_1_1util.html#aa74a8b46a5b38021c662a0b3bdfb46bf">ipc::util::PRODUCER_CONSUMER_RESOURCE_PERMISSIONS_LVL_MAP</a></div><div class="ttdeci">const boost::array&lt; Permissions, size_t(Permissions_level::S_END_SENTINEL)&gt; PRODUCER_CONSUMER_RESOURCE_PERMISSIONS_LVL_MAP</div><div class="ttdoc">Maps general Permissions_level specifier to low-level Permissions value, when the underlying resource...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00041">util.cpp:42</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_aaaa1fe31f8d77f78345dec8fc95e9882"><div class="ttname"><a href="namespaceipc_1_1util.html#aaaa1fe31f8d77f78345dec8fc95e9882">ipc::util::IPC_KERNEL_PERSISTENT_RUN_DIR</a></div><div class="ttdeci">const fs::path IPC_KERNEL_PERSISTENT_RUN_DIR</div><div class="ttdoc">Absolute path to the directory (without trailing separator) in the file system where kernel-persisten...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00063">util.cpp:63</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_aaf368acf8243bb25de3eef4e836c15de"><div class="ttname"><a href="namespaceipc_1_1util.html#aaf368acf8243bb25de3eef4e836c15de">ipc::util::Pipe_reader</a></div><div class="ttdeci">boost::asio::readable_pipe Pipe_reader</div><div class="ttdoc">Short-hand for anonymous pipe read end.</div><div class="ttdef"><b>Definition:</b> <a href="detail_2util__fwd_8hpp_source.html#l00035">util_fwd.hpp:35</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_abd43da87aa17031604c7906757c07d46"><div class="ttname"><a href="namespaceipc_1_1util.html#abd43da87aa17031604c7906757c07d46">ipc::util::op_with_possible_bipc_exception</a></div><div class="ttdeci">void op_with_possible_bipc_exception(flow::log::Logger *logger_ptr, Error_code *err_code, const Error_code &amp;misc_bipc_lib_error, String_view context, const Func &amp;func)</div><div class="ttdoc">Internal (to ipc) utility that invokes the given function that invokes a boost.interprocess operation...</div><div class="ttdef"><b>Definition:</b> <a href="util_8hpp_source.html#l00034">util.hpp:34</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae6ac47812a90d1287c61e0b7de7bc4f5"><div class="ttname"><a href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">ipc::util::String_view</a></div><div class="ttdeci">flow::util::String_view String_view</div><div class="ttdoc">Short-hand for Flow's String_view.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00115">util_fwd.hpp:115</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="ashared__name__fwd_8hpp_html"><div class="ttname"><a href="shared__name__fwd_8hpp.html">shared_name_fwd.hpp</a></div></div>
<div class="ttc" id="autil__fwd_8hpp_html"><div class="ttname"><a href="util__fwd_8hpp.html">util_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
